Northern Region Eclair Orders and Results FHIR API
Get Patient
Important Note
Eclair Get Patient request has a known issue. It returns a patient address element "State" having incorrect data, i.e., bore no relevance to the patient's actual address. Consumers are highly discouraged from requesting Eclair Patient Demographics data. Instead, Consumers are advised to use the Northern Region Patient FHIR API.
Patient Resource Implementation
Reference: http://hl7.org/fhir/R4/patient.html
| Element / Node Names | Description |
|---|---|
| address | An address for the individual |
| birthdate | The date of birth for the individual |
| deceasedBoolean | Indicates if the individual is deceased or not |
| extension - sex-at-birth | A person's sex at the time of their birth (considered to be immutable) |
| identifier | Patient NHI and/or Eclair internal patient ID |
| maritalStatus | Marital (civil) status of a patient |
| name | The name associated with the patient |
| resourceType | Represents the FHIR domain resource type |
Query Parameters
The following parameters are supported for performing queries on FHIR Patient resource. See http://hl7.org/fhir/R4/searchparameter-registry.html for further information.
| Data | Parameter | Example |
|---|---|---|
| NHI | patient.identifier | GET {{host}}/clinicaldocrepo/Eclair/Patient?identifier=standards.digital.health.nz/ns/nhi-id%7C[Patient NHI Here] |
| Internal patient ID | patient.identifier | GET {{host}}/clinicaldocrepo/Eclair/Patient?patient.identifier=ECLAIRSYSTEM%7C[Eclair System ID Here] |
| Partial name search | patient.name.family, patient.name.given | GET {{host}}/clinicaldocrepo/Eclair/Patient/_search?name=[family name,given name] |
Sample payloads
Request Payload
Response Payload
{
"resourceType": "Bundle",
"meta": {
"lastUpdated": "2023-09-29T12:45:18.4650467+13:00"
},
"type": "searchset",
"entry": [
{
"fullUrl": "https://eclair-api-acc.hanz.health.nz/EclairResourceServer/Eclair/Patient/ECLAIRSYSTEM|3131151",
"resource": {
"resourceType": "Patient",
"id": "531c7a2c-2d49-4008-8259-4504da22f8d0",
"extension": [
{
"url": "http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth",
"valueString": "Male"
}
],
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "https://standards.digital.health.nz/ns/nhi-id",
"code": "National Health Index (NHI)"
}
],
"text": "National Health Index (NHI)"
},
"system": "https://standards.digital.health.nz/ns/nhi-id",
"value": "ZZZ0032"
}
],
"name": [
{
"use": "official",
"family": "A",
"given": [
"TE",
"AWA"
],
"prefix": [
"MR"
]
}
],
"birthDate": "1996-08-29",
"deceasedBoolean": false,
"address": [
{
"use": "home",
"type": "both",
"line": [
"11 GARRETT STREET"
],
"city": "WELLINGTON",
"state": "Auckland",
"postalCode": "6011",
"country": "NEW ZEALAND"
}
],
"contact": [
{
"telecom": [
{
"system": "email",
"value": "lisa.bloomfield@healthalliance.co.nz",
"use": "work"
},
{
"system": "phone",
"value": "096250000",
"use": "work"
},
{
"system": "phone",
"value": "099999999",
"use": "home"
}
]
}
]
},
"search": {
"mode": "match"
}
}
]
}